home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 3 / Cream of the Crop 3.iso / utility / xmore12.zip / XMORE.DOC < prev   
Text File  |  1993-12-12  |  8KB  |  244 lines
  1.  
  2.                                  xMore 1.2
  3.                               12 December 1993
  4.  
  5.          Copyright (c) 1993 by Jorma Oksanen. All rights reserved.
  6.  
  7. xMore is a freely distributable, copyrighted piece of software.
  8.  
  9. Since xMore is free, it comes with NO WARRANTIES.  The author is not
  10. responsible for any loss or damage arising from the use or inability to use
  11. of xMore; the user takes all such responsibility.
  12.  
  13. No charge may be made for xMore, other than a nominal copy fee.  xMore may not
  14. be distributed with a commercial product without the author's prior
  15. consent.  xMore must be distributed with all documentation intact and
  16. unaltered.  Permission is expressly granted to Fred Fish to distribute on
  17. his fine collection of disks.
  18.  
  19. Although xMore is freeware, DONATIONS WOULD BE GLADLY ACCEPTED, either
  20. money or stuff you've written yourself.
  21.  
  22.  
  23. What is it?
  24. -----------
  25.  
  26.   Yet another file reader, you might think, and you are right.  I missed
  27. small XPK-understanding file reader with reasonable feature list, but there
  28. was none available.  Most ( (c) 1992 by Uwe R÷hm) can hardly be called
  29. small (but it surely has 'reasonable' feature list!).  I have to admit that
  30. xMore is currently bigger than I planned it to be, but people don't seem to
  31. want small programs, they want features!  So, what do you get?
  32.  
  33.     - light speed search! No loss of speed even if case insensitive
  34.       and/or backwards!
  35.     - hex mode
  36.     - fast scrolling
  37.     - font sensitivity
  38.     - multiple files from shell, Workbench and file requester!
  39.     - opens on default public screen with display sized window
  40.     - variable TAB size! (now you can read those funny #?.c
  41.       files with too much TABs ;)
  42.     - freely definable keys!
  43.     - lots of small details like default zoomed size exactly one
  44.       line high. Small things make the difference!
  45.     - OS 2.04 required (sorry, v36 users. There just is too much
  46.       functions in RKMs with text 'this function is broken in V36'
  47.       that I didn't bother dodging them. To pre-2.0 users xMore is
  48.       Yet Another Reason To Update. Come on guys, do you use CP/M
  49.       at work or what ? ;)
  50.  
  51.  
  52. Installation
  53. ------------
  54.  
  55.   Just copy it!  If you want to get most of it, check that you have in your
  56. LIBS:  drawer the following libraries:
  57.  
  58.   asl.library        needed for file requester
  59.   xpkmaster.library    reason for xMore's existence!
  60.   commodities.library    needed for defining keys (more about that later)
  61.  
  62.   xMore works just fine without any (disk-based) libraries, so it's easy to
  63. use with floppy systems and distribution disks.
  64.  
  65.  
  66. Usage
  67. -----
  68.  
  69. From workbench:
  70.  
  71.   Just double-click on xMore's icon and it will open the file requester.
  72. Alternatively you can select one or more text files with extended selection
  73. (RTM) and then double-click on xMore.  And ofcourse it works fine as
  74. default tool, too.
  75.  
  76.   If you give a drawer to xMore as one of the arguments, xMore will open
  77. file requester in that drawer.
  78.  
  79. From shell:
  80.  
  81.   Type "xMore" followed with zero or more file names.  xMore works just as
  82. from Workbench:  without arguments it opens file requester, if you give it
  83. a directory name, file requester opens there.  By the way, it makes no
  84. sense to give more than one drawer to xMore.
  85.  
  86.  
  87.   You can use multiple selection from file requester too.  xMore does not
  88. close it's window until you quit the last file you gave to it, but you can
  89. force it to quit without reading rest of files using control-esq (or
  90. whatever key you have binded FORCEQUIT to).
  91.  
  92.  
  93. About ANSI
  94. ----------
  95.  
  96.   xMore strips ANSI codes away.  That allows faster scrolling, and as most
  97. files don't contain ANSI (and hardly any of the ones that do use it to add
  98. readability) I didn't bother.  Styles may be added later, but don't expect
  99. to see any color in xMore (unless I hear fron zillions of users that they
  100. can't live without it, that is).
  101.  
  102.  
  103. Keyboard
  104. --------
  105.  
  106.   Starting from version 1.2 xMore supports freely definable keymapping.  I
  107. got quite much suggestions like "why can't I jump-to-line with g?" (uh, you
  108. can!  It was just forgotten from so called docs.  Be adventurous!  Push
  109. undefined buttons!  Or better yet:  pull 'em !  ;), "xMore jumps to bottom
  110. with b.  In UN*X it goes page back" etc.  My first thought was "I can't
  111. please everybody".  Bit later (week or two):  "EUREKA!".  Why couldn't I
  112. let user define keys himself.  And bit later (yep) it works.
  113.  
  114.   To define keys yourself create file "ENV:xMore/keys" (don't forget to
  115. copy it to "ENVARC:xMore/keys" !) which is read by xMore every time it's
  116. started.  Each line describes one action and one key:  <ACTION>=<key>.
  117. Note that equal sign ("=") must follow <action> without any blanks.  The
  118. case of the characters IS significant.  Lines starting with ";" are ignored
  119. just for those who need to comment everything.
  120.  
  121.   Following is a list of all defined actions with their default key bindings
  122. and keywords.  If default key is missing, that just means that you need to
  123. define it yourself if you want it.
  124.  
  125. Action            Default            Keyword
  126.  
  127. Up one line        up            UP
  128. Down one line        down            DOWN
  129. Left TAB chars        left            LEFT
  130. Right TAB chars        right            RIGHT
  131.  
  132. Up one page        shift up        PAGEUP
  133. Down one page        shift down        PAGEDOWN
  134. Beginning of line    shift/alt/control left    STARTOFLINE
  135.  
  136. Beginning of file    control up        TOP
  137. End of file        control down        BOTTOM
  138.  
  139. Scroll up one page    backspace        SCROLLUP
  140. Scroll down one page    space            SCROLLDOWN
  141.  
  142. Search case insensitive    s            SEARCH
  143. Search case sensitive    shift s            SEARCHCASE
  144. Search next        n            NEXT
  145. Search previous        p            PREVIOUS
  146.  
  147. Goto bookmark        F1 .. F10
  148. Set bookmark        shift F1 .. shift F10
  149.  
  150. Goto line        g            GOTOLINE
  151. Set TAB size        tab            SETTAB
  152. Set mode to ASCII                ASCIIMODE
  153. Set mode to HEX                    HEXMODE
  154. Hex/ASCII toggle    h            TOGGLEMODE
  155. Full redraw        r            REDRAW
  156.  
  157. Load new file(s)    l            LOAD
  158. Quit/Next file        ESC            QUIT
  159. Force quit        ctrl-ESC        FORCEQUIT
  160.  
  161. Do nothing                    NOP
  162.  
  163.  
  164.   If you define two (or more!) actions to same key, the later will be used.
  165. This allows you to override default keys.  NOP is useful if you want to
  166. cancel default key without giving it new action.
  167.  
  168.  
  169. Thanks
  170. ------
  171.  
  172.   To all of my beta testers (there are lots of them - I consider 1.0 as
  173. beta version of 1.1!).
  174.  
  175.   To Urban Dominic Mueller, Bryan Ford and all others who make XPK feel
  176. better than sliced bread.
  177.  
  178.   And last but not least to Tommi Lahtonen for being my link to the net.
  179.  
  180.  
  181. History
  182. -------
  183.  
  184. ; 1.0    ????
  185. ;
  186. ;    First public release
  187. ;
  188. ; 1.1    15.10.1993
  189. ;
  190. ;    If file was considered non-ASCII hex flag was toggled, not set.
  191. ;    All errors given in requester if started from WB or run in
  192. ;    background shell.
  193. ;    Opens filerequester in specified directory (from WB too!).
  194. ;    Filerequester defaults to previous files directory.
  195. ;    Filename in window title no longer shows path.
  196. ;    If given file is not found, and name does not end with
  197. ;    ".xpk" or ".pp", xMore tries these exensions before reporting
  198. ;    error. This is true only from workbench arguments.
  199. ;    Search works in hex mode (it worked before, but position to jump
  200. ;    to was calculated in ASCII-lines).
  201. ;    Bookmarks now refer to line start address instead of line number
  202. ;    to fix above mentioned hex-mode problem.
  203. ;    Cursor left with ANY qualifier moves to extreme left
  204. ;
  205. ; 1.2     9.12.1993
  206. ;    Attempting to prevent Great Keymapping Wars xMore now features
  207. ;    arbitrary keymapping if commodities.library is available.
  208. ;    Only ROM-based libraries are absolutely necessary.
  209. ;    Lots of internal restructuring. Source looks much nicer now ;)
  210. ;    At last distributed with something that can be called documentation
  211. ;    (not perfect yet; coding is much easier than writing docs!).
  212.  
  213.  
  214. Future
  215. ------
  216.  
  217.   Tooltypes.  Forced ascii/hex mode.  Open on definable pubscreen.
  218. Definable window dimensions.  User definable font.  Launch ENV:editor from
  219. xMore.  Up/down paragraph with alt up/down.  Bold, italics, underline.
  220. Wildcard search (maybe just '?' to keep it fast?).  Menus.  App
  221. icon/window.  Pipe support.  Help!  Word wrap.  Show percentage.  Goto
  222. percentage.  Ability to read crypted files.  Multi-window mode.
  223. Ralliraidat.  etc.
  224.  
  225.   And maybe some bug fixes...  Come on guys (and gals!), send me bug
  226. reports.  I know of several minor bugs which I won't bother to fix before
  227. someone else mentions them.
  228.  
  229.  
  230. Contacting the author
  231. ---------------------
  232.  
  233.   I can be reached with comments, suggestions, bug reports, praise, money
  234. etc.  at the following address:
  235.  
  236.     Jorma Oksanen
  237.     Ratastie 5 A 3
  238.     14200 TURENKI
  239.     FINLAND
  240.  
  241. or by e-mail: hazor@niksula.hut.fi
  242.               tlahtone@snakemail.hut.fi
  243.  
  244.